Reports > How reports work

 

How reports work

1 Reports are accessible through the Site > Reports... menu. When chosen, this menu item displays a dialog box from which the user selects reports to run on a choice of targets.
2 The user selects which files to run the selected reports on using the Report On: menu. This menu contains Current Document, All Files in Current Local Site, Selected Files In Local Site, and Folder. When the Folder option is selected, a Browse button and edit field appear to let the user choose a folder.
3 The user can customize reports that have parameters by choosing the Settings button, then entering values for the parameters. Each report is responsible for displaying its own Settings dialog box. This dialog box is optional; not every report will require the user to set the report's parameters. If a report does not have a Settings dialog box, then the Report Settings... button is dimmed when the report is selected in the list.
4 After the reports are selected and their settings set, the user clicks the Run button.
Each report that defines the beforeReporting() function has that function called before the reporting process begins. If a report returns false from this function, it is removed from the report run.
5 Each file is passed to each report that was selected in the Reports dialog box using the processFile() function. If the report needs to include information about this file in the results list, it should call the dw.results.addResultItem() function. This process continues until all files pertaining to the user's selection have been processed, or the user clicks the Stop button in the bottom of the window. Dreamweaver displays the name of each file being processed and the number of remaining files to be processed.
Each report that defines the endReporting() function has that function called after the reporting process completes.
6 The results of each report process appear in a separate Results window.